<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>XS::APItest - Test the perl C API - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/XS::APItest">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./XS::APItest.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/XS::APItest">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/XS::APItest">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/XS::APItest">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/XS::APItest">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/XS::APItest">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/XS::APItest">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/XS::APItest">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/XS::APItest">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/XS::APItest">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/XS::APItest">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/XS::APItest">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/XS::APItest">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/XS::APItest">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/XS::APItest">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/XS::APItest">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/XS::APItest">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/XS::APItest">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/XS::APItest">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/XS::APItest">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/XS::APItest">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/XS::APItest">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/XS::APItest">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/XS::APItest">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/XS::APItest">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/XS::APItest">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/XS::APItest">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/XS::APItest">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/XS::APItest">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/XS::APItest">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/XS::APItest">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/XS::APItest">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/XS::APItest">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/XS::APItest">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/XS::APItest">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/XS::APItest">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/XS::APItest">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/XS::APItest">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/XS::APItest">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/XS::APItest">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/XS::APItest">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/XS::APItest">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/XS::APItest">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/XS::APItest">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/XS::APItest">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/XS::APItest">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/XS::APItest">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/XS::APItest">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/XS::APItest">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/XS::APItest">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/XS::APItest">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/XS::APItest">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/XS::APItest">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/XS::APItest">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/XS::APItest">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/XS::APItest">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/XS::APItest">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/XS::APItest">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/XS::APItest">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/XS::APItest">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/XS::APItest">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/XS::APItest">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/XS::APItest">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/XS::APItest">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/XS::APItest">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/XS::APItest">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/XS::APItest">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/XS::APItest">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/XS::APItest">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/XS::APItest">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/XS::APItest">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/XS::APItest">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/XS::APItest">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/XS::APItest">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/XS::APItest">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/XS::APItest">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/XS::APItest">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/XS::APItest">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/XS::APItest">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/XS::APItest">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/XS::APItest">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./XS::APItest.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/XS::APItest">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/XS::APItest">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/XS::APItest">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/XS::APItest">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/XS::APItest">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/XS::APItest">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/XS::APItest">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/XS::APItest">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/XS::APItest">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/XS::APItest">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/XS::APItest">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/XS::APItest">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/XS::APItest">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/XS::APItest">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/XS::APItest">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/XS::APItest">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/XS::APItest">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/XS::APItest">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/XS::APItest">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/XS::APItest">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/XS::APItest">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/XS::APItest">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/XS::APItest">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/XS::APItest">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/XS::APItest">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/XS::APItest">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/XS::APItest">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/XS::APItest">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/XS::APItest">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/XS::APItest">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/XS::APItest">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/XS::APItest">5.35.1</a>
          <a class="dropdown-item active" href="./XS::APItest.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./XS::APItest.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./XS::APItest.html">XS::APItest</a>
          <div id="more">
            (<a href="./XS::APItest.txt">source</a>,
            <a href="https://metacpan.org/pod/XS::APItest">CPAN</a>)
          </div>
            <div id="moduleversion">version 1.16</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#ABSTRACT">ABSTRACT</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#DESCRIPTION">DESCRIPTION</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#EXPORT">EXPORT</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#KEYWORDS">KEYWORDS</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#RPN-expression-syntax">RPN expression syntax</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#SEE-ALSO">SEE ALSO</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#AUTHORS">AUTHORS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./XS::APItest.html#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./XS::APItest.html#NAME">#</a>NAME</h1>

<p>XS::APItest - Test the perl C API</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./XS::APItest.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>use XS::APItest;
print_double(4);

use XS::APItest qw(rpn calcrpn);
$triangle = rpn($n $n 1 + * 2 /);
calcrpn $triangle { $n $n 1 + * 2 / }</code></pre>

<h1 id="ABSTRACT"><a class="permalink" href="./XS::APItest.html#ABSTRACT">#</a>ABSTRACT</h1>

<p>This module tests the perl C API. Also exposes various bit of the perl internals for the use of core test scripts.</p>

<h1 id="DESCRIPTION"><a class="permalink" href="./XS::APItest.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>This module can be used to check that the perl C API is behaving correctly. This module provides test functions and an associated test script that verifies the output.</p>

<p>This module is not meant to be installed.</p>

<h2 id="EXPORT"><a class="permalink" href="./XS::APItest.html#EXPORT">#</a>EXPORT</h2>

<p>Exports all the test functions:</p>

<dl>

<dt id="print_double"><a class="permalink" href="./XS::APItest.html#print_double">#</a><b>print_double</b></dt>
<dd>

<p>Test that a double-precision floating point number is formatted correctly by <code>printf</code>.</p>

<pre><code>print_double( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="print_long_double"><a class="permalink" href="./XS::APItest.html#print_long_double">#</a><b>print_long_double</b></dt>
<dd>

<p>Test that a <code>long double</code> is formatted correctly by <code>printf</code>. Takes no arguments - the test value is hard-wired into the function (as &quot;7&quot;).</p>

<pre><code>print_long_double();</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="have_long_double"><a class="permalink" href="./XS::APItest.html#have_long_double">#</a><b>have_long_double</b></dt>
<dd>

<p>Determine whether a <code>long double</code> is supported by Perl. This should be used to determine whether to test <code>print_long_double</code>.</p>

<pre><code>print_long_double() if have_long_double;</code></pre>

</dd>
<dt id="print_nv"><a class="permalink" href="./XS::APItest.html#print_nv">#</a><b>print_nv</b></dt>
<dd>

<p>Test that an <code>NV</code> is formatted correctly by <code>printf</code>.</p>

<pre><code>print_nv( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="print_iv"><a class="permalink" href="./XS::APItest.html#print_iv">#</a><b>print_iv</b></dt>
<dd>

<p>Test that an <code>IV</code> is formatted correctly by <code>printf</code>.</p>

<pre><code>print_iv( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="print_uv"><a class="permalink" href="./XS::APItest.html#print_uv">#</a><b>print_uv</b></dt>
<dd>

<p>Test that an <code>UV</code> is formatted correctly by <code>printf</code>.</p>

<pre><code>print_uv( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="print_int"><a class="permalink" href="./XS::APItest.html#print_int">#</a><b>print_int</b></dt>
<dd>

<p>Test that an <code>int</code> is formatted correctly by <code>printf</code>.</p>

<pre><code>print_int( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="print_long"><a class="permalink" href="./XS::APItest.html#print_long">#</a><b>print_long</b></dt>
<dd>

<p>Test that an <code>long</code> is formatted correctly by <code>printf</code>.</p>

<pre><code>print_long( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="print_float"><a class="permalink" href="./XS::APItest.html#print_float">#</a><b>print_float</b></dt>
<dd>

<p>Test that a single-precision floating point number is formatted correctly by <code>printf</code>.</p>

<pre><code>print_float( $val );</code></pre>

<p>Output is sent to STDOUT.</p>

</dd>
<dt id="filter"><a class="permalink" href="./XS::APItest.html#filter">#</a><b>filter</b></dt>
<dd>

<p>Installs a source filter that substitutes &quot;e&quot; for &quot;o&quot; (witheut regard fer what it might be medifying).</p>

</dd>
<dt id="call_sv,-call_pv,-call_method"><a class="permalink" href="./XS::APItest.html#call_sv,-call_pv,-call_method">#</a><a id="call_sv"></a><a id="call_sv-call_pv-call_method"></a><b>call_sv</b>, <b>call_pv</b>, <b>call_method</b></dt>
<dd>

<p>These exercise the C calls of the same names. Everything after the flags arg is passed as the args to the called function. They return whatever the C function itself pushed onto the stack, plus the return value from the function; for example</p>

<pre><code>call_sv( sub { @_, &#39;c&#39; }, G_ARRAY,  &#39;a&#39;, &#39;b&#39;);
# returns &#39;a&#39;, &#39;b&#39;, &#39;c&#39;, 3
call_sv( sub { @_ },      G_SCALAR, &#39;a&#39;, &#39;b&#39;);
# returns &#39;b&#39;, 1</code></pre>

</dd>
<dt id="eval_sv"><a class="permalink" href="./XS::APItest.html#eval_sv">#</a><b>eval_sv</b></dt>
<dd>

<p>Evaluates the passed SV. Result handling is done the same as for <code>call_sv()</code> etc.</p>

</dd>
<dt id="eval_pv"><a class="permalink" href="./XS::APItest.html#eval_pv">#</a><b>eval_pv</b></dt>
<dd>

<p>Exercises the C function of the same name in scalar context. Returns the same SV that the C function returns.</p>

</dd>
<dt id="require_pv"><a class="permalink" href="./XS::APItest.html#require_pv">#</a><b>require_pv</b></dt>
<dd>

<p>Exercises the C function of the same name. Returns nothing.</p>

</dd>
</dl>

<h1 id="KEYWORDS"><a class="permalink" href="./XS::APItest.html#KEYWORDS">#</a>KEYWORDS</h1>

<p>These are not supplied by default, but must be explicitly imported. They are lexically scoped.</p>

<dl>

<dt id="DEFSV"><a class="permalink" href="./XS::APItest.html#DEFSV">#</a>DEFSV</dt>
<dd>

<p>Behaves like <code>$_</code>.</p>

</dd>
<dt id="rpn(EXPRESSION)"><a class="permalink" href="./XS::APItest.html#rpn(EXPRESSION)">#</a><a id="rpn"></a><a id="rpn-EXPRESSION"></a>rpn(EXPRESSION)</dt>
<dd>

<p>This construct is a Perl expression. <i>EXPRESSION</i> must be an RPN arithmetic expression, as described below. The RPN expression is evaluated, and its value is returned as the value of the Perl expression.</p>

</dd>
<dt id="calcrpn-VARIABLE-{-EXPRESSION-}"><a class="permalink" href="./XS::APItest.html#calcrpn-VARIABLE-%7B-EXPRESSION-%7D">#</a><a id="calcrpn"></a><a id="calcrpn-VARIABLE-EXPRESSION"></a>calcrpn VARIABLE { EXPRESSION }</dt>
<dd>

<p>This construct is a complete Perl statement. (No semicolon should follow the closing brace.) <i>VARIABLE</i> must be a Perl scalar <code>my</code> variable, and <i>EXPRESSION</i> must be an RPN arithmetic expression as described below. The RPN expression is evaluated, and its value is assigned to the variable.</p>

</dd>
</dl>

<h2 id="RPN-expression-syntax"><a class="permalink" href="./XS::APItest.html#RPN-expression-syntax">#</a><a id="RPN"></a>RPN expression syntax</h2>

<p>Tokens of an RPN expression may be separated by whitespace, but such separation is usually not required. It is required only where unseparated tokens would look like a longer token. For example, <code>12 34 +</code> can be written as <code>12 34+</code>, but not as <code>1234 +</code>.</p>

<p>An RPN expression may be any of:</p>

<dl>

<dt id="1234"><a class="permalink" href="./XS::APItest.html#1234">#</a><a id="pod1234"></a><code>1234</code></dt>
<dd>

<p>A sequence of digits is an unsigned decimal literal number.</p>

</dd>
<dt id="$foo"><a class="permalink" href="./XS::APItest.html#$foo">#</a><a id="foo"></a><code>$foo</code></dt>
<dd>

<p>An alphanumeric name preceded by dollar sign refers to a Perl scalar variable. Only variables declared with <code>my</code> or <code>state</code> are supported. If the variable&#39;s value is not a native integer, it will be converted to an integer, by Perl&#39;s usual mechanisms, at the time it is evaluated.</p>

</dd>
<dt id="A-B-+"><a class="permalink" href="./XS::APItest.html#A-B-+">#</a><a id="A"></a><a id="A-B"></a><i>A</i> <i>B</i> <code>+</code></dt>
<dd>

<p>Sum of <i>A</i> and <i>B</i>.</p>

</dd>
<dt id="A-B-"><a class="permalink" href="./XS::APItest.html#A-B-">#</a><a id="A1"></a><a id="A-B1"></a><i>A</i> <i>B</i> <code>-</code></dt>
<dd>

<p>Difference of <i>A</i> and <i>B</i>, the result of subtracting <i>B</i> from <i>A</i>.</p>

</dd>
<dt id="A-B-*"><a class="permalink" href="./XS::APItest.html#A-B-*">#</a><a id="A2"></a><a id="A-B2"></a><i>A</i> <i>B</i> <code>*</code></dt>
<dd>

<p>Product of <i>A</i> and <i>B</i>.</p>

</dd>
<dt id="A-B-/"><a class="permalink" href="./XS::APItest.html#A-B-/">#</a><a id="A3"></a><a id="A-B3"></a><i>A</i> <i>B</i> <code>/</code></dt>
<dd>

<p>Quotient when <i>A</i> is divided by <i>B</i>, rounded towards zero. Division by zero generates an exception.</p>

</dd>
<dt id="A-B-%"><a class="permalink" href="./XS::APItest.html#A-B-%25">#</a><a id="A4"></a><a id="A-B4"></a><i>A</i> <i>B</i> <code>%</code></dt>
<dd>

<p>Remainder when <i>A</i> is divided by <i>B</i> with the quotient rounded towards zero. Division by zero generates an exception.</p>

</dd>
</dl>

<p>Because the arithmetic operators all have fixed arity and are postfixed, there is no need for operator precedence, nor for a grouping operator to override precedence. This is half of the point of RPN.</p>

<p>An RPN expression can also be interpreted in another way, as a sequence of operations on a stack, one operation per token. A literal or variable token pushes a value onto the stack. A binary operator pulls two items off the stack, performs a calculation with them, and pushes the result back onto the stack. The stack starts out empty, and at the end of the expression there must be exactly one value left on the stack.</p>

<h1 id="SEE-ALSO"><a class="permalink" href="./XS::APItest.html#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1>

<p><a href="./XS::Typemap.html">XS::Typemap</a>, <a href="perlapi.html">perlapi</a>.</p>

<h1 id="AUTHORS"><a class="permalink" href="./XS::APItest.html#AUTHORS">#</a>AUTHORS</h1>

<p>Tim Jenness, &lt;t.jenness@jach.hawaii.edu&gt;, Christian Soeller, &lt;csoelle@mph.auckland.ac.nz&gt;, Hugo van der Sanden &lt;hv@crypt.compulink.co.uk&gt;, Andrew Main (Zefram) &lt;zefram@fysh.org&gt;</p>

<h1 id="COPYRIGHT-AND-LICENSE"><a class="permalink" href="./XS::APItest.html#COPYRIGHT-AND-LICENSE">#</a><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1>

<p>Copyright (C) 2002,2004 Tim Jenness, Christian Soeller, Hugo van der Sanden. All Rights Reserved.</p>

<p>Copyright (C) 2009 Andrew Main (Zefram) &lt;zefram@fysh.org&gt;</p>

<p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
